Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: add tips and tricks page #543

Merged
merged 20 commits into from
Feb 27, 2024
Merged

docs: add tips and tricks page #543

merged 20 commits into from
Feb 27, 2024

Conversation

isabelroses
Copy link
Member

@isabelroses isabelroses commented Feb 20, 2024 •
edited by uncenter
Loading

Following up on #449.
This PR:

  • Adds a guide on how to set up live reloading with Stylus, how to create a new userstyle with UserCSS on Stylus.
  • Documents how to blur/censor text in preview screenshots (with Flow Circular font).
  • Documents how to use SVGs as background-images.
  • Documents how to replace images created with <img> tags.
  • Adds installation and usage instructions for converting images to WebP (ideally temporary until Update to Rust native webp implementation catwalk#5 is done/resolved).

@isabelroses
Copy link
Member Author

As a note, I'm unsure where to put a link to new documentation.
I was thinking either general recommendations or at the end of userstyles creation.

nekowinston
nekowinston suggested changes Feb 20, 2024
View reviewed changes
docs/tips-and-tricks.md Outdated Show resolved Hide resolved
docs/tips-and-tricks.md Outdated Show resolved Hide resolved
nekowinston
nekowinston previously approved these changes Feb 20, 2024
View reviewed changes
uncenter
uncenter previously requested changes Feb 20, 2024
View reviewed changes
docs/tips-and-tricks.md Outdated Show resolved Hide resolved
docs/tips-and-tricks.md Outdated Show resolved Hide resolved
docs/tips-and-tricks.md Outdated Show resolved Hide resolved
docs/tips-and-tricks.md Outdated Show resolved Hide resolved
docs/tips-and-tricks.md Outdated Show resolved Hide resolved
docs/tips-and-tricks.md Show resolved Hide resolved
isabelroses and others added 5 commits February 20, 2024 16:31
@isabelroses @uncenter
chore: wording
4787b3d 
Co-authored-by: uncenter <47499684+uncenter@users.noreply.github.com>
@isabelroses @uncenter
chore: wording
a294bdb 
Co-authored-by: uncenter <47499684+uncenter@users.noreply.github.com>
@isabelroses @uncenter
chore: truncate additonal details
e290eba 
Co-authored-by: uncenter <47499684+uncenter@users.noreply.github.com>
@isabelroses @uncenter
style: capitlisation
216d516 
Co-authored-by: uncenter <47499684+uncenter@users.noreply.github.com>
@isabelroses
fix: capitals in title
f5db070
@uncenter uncenter changed the title feat(docs): tips and tricks docs: add tips and tricks page Feb 20, 2024
@uncenter
Copy link
Member

uncenter commented Feb 20, 2024 •
edited
Loading

Should we incorporate https://github.com/uncenter/ctp-userstyles/blob/docs-quick-tips/docs/quick-tips.md into this? Or add as a separate PR?

@isabelroses
Copy link
Member Author

Should we incorporate https://github.com/uncenter/ctp-userstyles/blob/docs-quick-tips/docs/quick-tips.md into this? Or add as a separate PR?

Bring it into this PR. We may as well do it in one go.

@nekowinston nekowinston removed their request for review February 20, 2024 18:49
isabelroses
isabelroses commented Feb 20, 2024
View reviewed changes
docs/tips-and-tricks.md Outdated Show resolved Hide resolved
docs/tips-and-tricks.md Show resolved Hide resolved
sgoudham
sgoudham previously requested changes Feb 20, 2024
View reviewed changes
Copy link
Contributor

@sgoudham sgoudham left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd appreciate if you could add a &nbsp; in between each ### block, similar to the https://github.com/catppuccin/userstyles/blob/main/docs/userstyle-creation.md

uncenter
uncenter reviewed Feb 21, 2024
View reviewed changes
docs/tips-and-tricks.md Outdated Show resolved Hide resolved
@isabelroses isabelroses dismissed sgoudham’s stale review February 23, 2024 22:24

change has been accomplished

uncenter
uncenter approved these changes Feb 27, 2024
View reviewed changes
Copy link
Member

@uncenter uncenter left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me. Better to merge now and we can iterate on it later than to keep it in this stage. I can make another PR maybe later this week to add more of the stuff in #449.

@isabelroses isabelroses merged commit 84578b2 into main Feb 27, 2024
5 checks passed
@isabelroses isabelroses deleted the docs/tips-and-tricks branch February 27, 2024 01:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@uncenter uncenter uncenter approved these changes

@sgoudham sgoudham sgoudham left review comments

@nekowinston nekowinston nekowinston left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@isabelroses @uncenter @sgoudham @nekowinston @GenShibe